Interface InstructionDlg

All Superinterfaces:
IPCObject
All Known Implementing Classes:
InstructionDlgImpl

public interface InstructionDlg extends IPCObject
Information provided by the PKI file:

    \class InstructionDlg
    
    \brief InstructionDlg is the instruction dialog associated with activity files.
    
    \example appWindow().getInstructionDlg()
    
Author:
Auto-generated
  • Method Details

    • resetActivity

      void resetActivity()
      Information provided by the PKI file:
      
          \brief Resets the activity.
          
              
    • showAnswerPage

      void showAnswerPage(boolean bResetOnClose)
      Information provided by the PKI file:
      
          \brief Shows the Check Results page.
          
          \param bResetOnClose, true to reset the activity after closing the Check Results page, false to not reset the activity.
          
              
      Parameters:
      bResetOnClose - Takes in a parameter of bResetOnClose
    • closeAnswerPage

      void closeAnswerPage()
      Information provided by the PKI file:
      
          \brief Closes the Check Results page.
          
              
    • prev

      void prev()
      Information provided by the PKI file:
      
          \brief Shows the previous instruction page.
          
              
    • next

      void next()
      Information provided by the PKI file:
      
          \brief Shows the next instruction page.
          
              
    • alwaysOnTop

      void alwaysOnTop(boolean bOn)
      Information provided by the PKI file:
      
          \brief Enables or disables the always on top feature.
          
          \param bOn, true to enable the always on top feature, false to disable it.
          
              
      Parameters:
      bOn - Takes in a parameter of bOn
    • dock

      void dock()
      Information provided by the PKI file:
      
          \brief Dock the instructions dialog to the left of the main window.
          
              
    • undock

      void undock()
      Information provided by the PKI file:
      
          \brief Undock the instructions dialog.
          
              
    • isDocked

      boolean isDocked()
      Information provided by the PKI file:
      
          \brief Returns true if instructions dialog is docked, false otherwise.
          
          \return bool, true if instructions dialog is docked, false otherwise.
          
              
      Returns:
      boolean Returns a boolean
    • setVisible

      void setVisible(boolean bVisible)
      Information provided by the PKI file:
      
          \brief Shows or hides this widget from view.
          
          \param bVisible, true to show this widget, false to hide it.
          
              
      Parameters:
      bVisible - Takes in a parameter of bVisible
    • setWidgetVisible

      void setWidgetVisible(String widgetName, boolean bVisible)
      Information provided by the PKI file:
      
          \brief Shows or hides the specified child widget.
          
          \param widgetName, where widgetName can be one of the following: checkAnswerBtn, resetBtn, prevBtn, nextBtn, topCB, progressLbl, timeLbl.
          \param bVisible, true to show this child widget, false to hide it.
          
              
      Parameters:
      widgetName - Takes in a parameter of widgetName
      bVisible - Takes in a parameter of bVisible
    • setDisabled

      void setDisabled(boolean bDisabled)
      Information provided by the PKI file:
      
          \brief Enables or disables input events to this widget.
          
          \param bDisabled, true to disable input events to this widget, false to enable input events.
          
              
      Parameters:
      bDisabled - Takes in a parameter of bDisabled
    • setWidgetDisable

      void setWidgetDisable(String widgetName, boolean bDisabled)
      Information provided by the PKI file:
      
          \brief Enables or disables the specified child widget.
          
          \param widgetName, where widgetName can be one of the following: checkAnswerBtn, resetBtn, prevBtn, nextBtn, topCB, progressLbl, timeLbl.
          \param bDisabled, true to disable input events to this child widget, false to enable input events.
          
              
      Parameters:
      widgetName - Takes in a parameter of widgetName
      bDisabled - Takes in a parameter of bDisabled
    • isEditInstructionsLocked

      boolean isEditInstructionsLocked()
      Information provided by the PKI file:
      
          \brief Returns true if edit instructions is locked, otherwise false.
          
          \return bool, true if edit instructions is locked, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setEditInstructionsLocked

      void setEditInstructionsLocked(boolean bLock)
      Information provided by the PKI file:
      
          \brief Enables or disables the locking of edit instructions.
          
          \param bLock, true to lock editing instructions, false to allow editing instructions.
          
              
      Parameters:
      bLock - Takes in a parameter of bLock
    • setWindowGeometry

      void setWindowGeometry(int x, int y, int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the instruction dialog geometry and position.
          
          \param x, the x-coordinate to move the instruction dialog to.
          \param x, the y-coordinate to move the instruction dialog to.
          \param width, the width for the instruction dialog.
          \param height, the height for the instruction dialog.
          
              
      Parameters:
      x - Takes in a parameter of x
      y - Takes in a parameter of y
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • getX

      int getX()
      Information provided by the PKI file:
      
          \brief Returns the x-coordinate of the instruction dialog.
          
          \return int, the x-coordinate of the instruction dialog.
          
              
      Returns:
      int Returns a int
    • getY

      int getY()
      Information provided by the PKI file:
      
          \brief Returns the y-coordinate of the instruction dialog.
          
          \return int, the y-coordinate of the instruction dialog.
          
              
      Returns:
      int Returns a int
    • getWidth

      int getWidth()
      Information provided by the PKI file:
      
          \brief Returns the width of the instruction dialog.
          
          \return int, the width of the instruction dialog.
          
              
      Returns:
      int Returns a int
    • getHeight

      int getHeight()
      Information provided by the PKI file:
      
          \brief Returns the height of the instruction dialog.
          
          \return int, the height of the instruction dialog.
          
              
      Returns:
      int Returns a int
    • raise

      void raise()
      Information provided by the PKI file:
      
          \brief Brings the instruction dialog to the front.
          
              
    • getWebView

      WebView getWebView()
      Information provided by the PKI file:
      
          \brief Returns the WebView object of the instruction dialog.
          
          \return WebView, the WebView object of the instruction dialog.
          
              
      Returns:
      WebView Returns a WebView
    • isShowCheckResultsLockMessage

      boolean isShowCheckResultsLockMessage()
      Information provided by the PKI file:
      
          \brief Returns true if show check results lock message, false otherwise.
          
          \return bool, true if show check results lock message, false otherwise.
          
              
      Returns:
      boolean Returns a boolean
    • setShowCheckResultsLockMessage

      void setShowCheckResultsLockMessage(boolean bShow)
      Information provided by the PKI file:
      
          \brief set to show check results lock message or not.
          
          \param bShow, true to show check result lock message, false to not show.
          
              
      Parameters:
      bShow - Takes in a parameter of bShow
    • overrideTimeLabel

      void overrideTimeLabel(String label, String timeDisplay)
      Information provided by the PKI file:
      
          \brief Overrides the time label in the instruction box
          
              
      Parameters:
      label - Takes in a parameter of label
      timeDisplay - Takes in a parameter of timeDisplay
    • overrideProgressLabel

      void overrideProgressLabel(String label, String progress)
      Information provided by the PKI file:
      
          \brief Overrides the progress label in the instruction box
          
              
      Parameters:
      label - Takes in a parameter of label
      progress - Takes in a parameter of progress
    • overrideInstructions

      void overrideInstructions()
      Information provided by the PKI file:
      
          \brief Overrides the instructions and the system will not update instructions anymore.
          
              
    • getTabWebView

      WebView getTabWebView(int index)
      Information provided by the PKI file:
      
          \brief Returns the web view in a tab.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      WebView Returns a WebView
    • setTabVisible

      void setTabVisible(int index, boolean visible)
      Information provided by the PKI file:
      
          \brief Shows or hides a tab.
          
              
      Parameters:
      index - Takes in a parameter of index
      visible - Takes in a parameter of visible
    • removeWidget

      boolean removeWidget(String name)
      Information provided by the PKI file:
      
          \brief Removes a widget that was previously added to the instruction dialog.
          
          \param name, the name of the widget
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      boolean Returns a boolean
    • setSliderValue

      boolean setSliderValue(String name, int value)
      Information provided by the PKI file:
      
          \brief Sets the value of a slider that was previously added to the instruction dialog.
          
          \param name, the name of the widget
          \param value, the value
          
              
      Parameters:
      name - Takes in a parameter of name
      value - Takes in a parameter of value
      Returns:
      boolean Returns a boolean
    • setLabelText

      boolean setLabelText(String name, String text)
      Information provided by the PKI file:
      
          \brief Sets the text on the label that was previously added to the instruction dialog.
          
          \param name, the name of the widget
          \param text, the text
          
              
      Parameters:
      name - Takes in a parameter of name
      text - Takes in a parameter of text
      Returns:
      boolean Returns a boolean
    • setWidgetToolTip

      boolean setWidgetToolTip(String name, String tooltip)
      Information provided by the PKI file:
      
          \brief Sets the tooltip for a widget that was previously added to the instruction dialog.
          
          \param name, the name of the widget
          \param tooltip, the tooltip
          
              
      Parameters:
      name - Takes in a parameter of name
      tooltip - Takes in a parameter of tooltip
      Returns:
      boolean Returns a boolean